home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / comms / other / amarquee / amarquee49.readme < prev    next >
Text File  |  1999-05-25  |  8KB  |  151 lines
  1. Short:    V49.8 TCP Data Broadcast System (library & server)
  2. Author:   hparting@hem.passagen.se (Håkan Parting & Jeremy Friesner)
  3. Uploader: hparting@hem.passagen.se (Håkan Parting)
  4. Version:  49.8
  5. Type:     comm/net
  6. Requires: Workbench 2.04+, Inet225 or AmiTCP3.0b+ or compatible TCP stack
  7.  
  8. ----------------------------------------------------------------
  9.  
  10.                           AMARQUEE v49.8
  11.  
  12.                     (Released May 16th 1999)
  13.  
  14. ----------------------------------------------------------------
  15.  
  16.  
  17. The Problem: 
  18.  
  19.  You have a great idea for a killer multi-player Internet game 
  20.  or multi-user net app, but it's a total pain in the @)#$* to 
  21.  write all the TCP connection and data synchronization code 
  22.  you'll need to get it going.  So you put your idea on the 
  23.  back-burner and go play "Lemmings" instead.  And thus the 
  24.  Amiga is deprived of a fun Internet app.  D-oh!  :(
  25.  
  26. The Solution:  (well, okay, it's *a* solution, anyway)
  27.  
  28.  AMarquee is a system that handles all of the icky information 
  29.  distribution details for you, allowing you to concentrate on 
  30.  coding your application, rather than on which data goes into 
  31.  which socket when.  AMarquee consists of a shared library and
  32.  a TCP daemon, which work together to get your data where it
  33.  needs to be.  Your program calls simple amarquee.library
  34.  functions to broadcast your data, and waits on a provided
  35.  MsgPort for data from other hosts.  Easy!
  36.  
  37.  Note that this now (from v.49) also work with any TCP service, like HTTP,
  38.  FTP and so on.
  39.  
  40. Features of amarquee.library (the shared library/API):
  41.  
  42.  - Programs written to use amarquee.library will work transparently
  43.    with Inet225, AmiTCP, Miami, or any other TCP stack that is 
  44.    "AmiTCP compatible".
  45.  - Has a simple API that requires no knowledge of multithreading 
  46.    techniques or socket programming to use.
  47.  - Each AMarquee connection you make automatically and transparently
  48.    starts a separate background execution thread, so your app will 
  49.    never have to block while data is sent or received.
  50.  - An arbitrary number of AMarquee connections may be active at once.
  51.  - Allows you to "subscribe" to data that interests you, so that
  52.    when the data on the server is changed you will be automatically 
  53.    notified.  You never need to poll for anything!
  54.  - An easy mechanism for sending messages to one or many other
  55.    AMarquee clients that are logged into the same server.
  56.  - Standard Amiga wildcarding is supported in all applicable functions.
  57.    This allows you to easily and succinctly refer to one host or data
  58.    item, or many, as appropriate.
  59.  - #includes for C, C++, and PCQ Pascal are included.
  60.  - ARexx accessible.  That is, ARexx scripts can use amarquee.library
  61.    through rexxamarquee.library for communications using the same API
  62.    that compiled C programs do.
  63.  - Example programs in C, C++, Pascal, and ARexx are included.
  64.  - Operation is almost totally asynchronous for efficiency, but
  65.    several easy synchronization methods are available if you need them.
  66.  - Can also be used for direct client-to-client connections and
  67.    for making inetd-launched or manually-launched daemon programs.
  68.  - Automatically detects when the computer on the other end of
  69.    the AMarquee connection has crashed or been shut down, even 
  70.    on idle connections.
  71.  - Can connect to any TCP servive, eg. HTTP and FTP, and it will work in
  72.    the same easy fashion like any other AMarquee connection.
  73.  
  74. Features of AMarqueed (the AmiTCP server):
  75.  
  76.  - Works with Inet225, AmiTCP, Miami, or any other TCP stack 
  77.    that is "AmiTCP compatible".
  78.  - Fully multithreaded design, with one server process per connection.
  79.  - Re-entrant code, to minimize memory usage.
  80.  - Data is stored in a filesystem-like tree structure for simplicity,
  81.    flexibility and efficiency.  Each client gets its own "home directory"
  82.    that it may write to or read from, and each client may also
  83.    read from the "home directories" of other clients.
  84.  - Efficient design minimizes CPU usage, net bandwidth, and execution time.
  85.  - Limits may be put on memory usage, number of connections, and/or 
  86.    which clients or apps may connect.  Only serve the hosts and apps
  87.    you want to serve!
  88.  - Supports data streaming to one or many clients at once.
  89.  - Data streaming and synchronization features let you be sure your 
  90.    data was read by all interested hosts before you update it again.
  91.  - Automatically detects and eliminates "dead" connections (e.g.
  92.    if the client computer was shut down without quitting politely)
  93.  - Server may be administered remotely by clients with "privileged"
  94.    status.
  95.  
  96. WHAT'S NEW IN VERSION 49.8:
  97. ( "-" = new feature, "*" = bug fix)
  98.  
  99. V49.8 : (Public Release 16-May-1999) (amarquee.library v49.6, rexxamarquee.library v49.6, AMarqueed v49.7)
  100. -    The current AMarqueed server name in the guide was updated.
  101. *    The examples AMarqueeSocketDebug.c and AMarqueeSocketHost.c that demonstrates the
  102.      new QNewSocketSession() functions in amarquee.library v.49. They shall be correct now.
  103. -    Add the examples GetURL.c and GetURL.rexx to the distribution. They show how to retreive
  104.      the index.html from a web-server. Both C and ARexx version included.
  105. -    The libraries and server were not updated.
  106.  
  107. V49.7 : (Public Release 14-Feb-1999) (amarquee.library v49.6, AMarqueed v49.7)
  108.  
  109. *   The fd-file and the inline include file for GCC had errors.
  110.  
  111. *   Race condition in AMarqueed fixed. Could only happen when no host were
  112.     connected to the server, and then suddenly two or more hosts connected to
  113.     the server in exactly the same moment. The two connecting hosts would then
  114.     be connected to two seperate isolated server instances running on the server
  115.     computer.
  116.     If those hosts were connecting with for example AmiComSys one of them would
  117.     only see himself in the client list.    
  118.  
  119. -   Added AMARQUEED_RESTRICTBROWSE and AMARQUEED_ALLOWBROWSE @{"environment variables" link UsingAMarqueed}
  120.  
  121. -   The library was not updated in this release.
  122.  
  123. V49.6 : (Public Release 16-Jan-1999) (amarquee.library v49.6)
  124.  
  125.  - AMarquee.library development taken over by Håkan Parting after Jeremy had ceased
  126.    development for Amiga.
  127.  * Fixed major bug in AMarqueed:
  128.    In certain circumstances it was possible to get attributes one
  129.    was not subscribing to. Eg. If a client subscribed to /happyhost.com/QAmiTrack/name
  130.    and /nothappyhost.com/QAmiTrack/comment, one would get 'comment'  from happyhost.com
  131.    and 'name' from nothappyhost.com in addition to what one wanted to receive.
  132.    If you subscribed on /localhost/QAmiTrack/comment and /qamitrack.tibb.at/QAmiTrack/comment.
  133.    You would receive two QMessages when one of these clients modify its data.
  134.    (Thanks to myself for fixing this! :)  
  135.  * Fixed certain things to make it compile right with DICE 3.0, instead of former DICE 2.0
  136.    compilation.
  137.  * Exchanged Forbid() and Permit() 's with Semaphores, so the multitasking won't get disabled
  138.    in unnecessary situations.
  139.  - JAVA 1.0.2 version of AMarquee, called JAMarquee, available at
  140.    http://hem.passagen.se/hparting/jamarquee/
  141.  - Moved the Arexx piece of code into a new library named, rexxamarquee.library. Use it instead
  142.    of amarquee.library. The lib-offset is now -30 as with any other ARexx-function-library.
  143.  - Added QNewSocketSession(), QNewSocketSessionAsync() and QNewSocketServerSession() functions
  144.    to the library.
  145.  - Added QSendRawOp() function to the library.
  146.  - Added QSetKeyAccessOp() function to the library.
  147.  - Added support for access restrictions on the keys in AMarqueed (for use with
  148.    QSetKeyAccessOp()).
  149.  * Fixed memory leakage that happened every time the client got a ping from the server :)
  150.  - Added QGetHostName() and QGetProgName() functions to the library.
  151.